home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / pagemkr / pmtags.exe / PMTAGS.DOC < prev    next >
Text File  |  1993-10-20  |  8KB  |  188 lines
  1.  
  2. NAME:
  3.    PMTAGS - Check/fix style tags in PageMaker ASCII import files
  4.  
  5.  
  6. SYNTAX:
  7.    pmtags [-f] [-h|?] [-sfile] [-v] [file...]
  8.  
  9.    [file...]   One or more ASCII text files prepared for importing
  10.                into PageMaker. Default extension is .TAG.
  11.  
  12.    -f[output]  Fix end-of-line's, paragraphs, style tags and other
  13.                formatting (where possible), writing output to
  14.                <input-file>.TXT.
  15.  
  16.    -h, -?      Display help information.
  17.  
  18.    -sfile      Specify an alternative file containing a list of valid style
  19.                names.  If this option is not specified, the default name is
  20.                PMSTYLES.DAT. pmtags will search the current directory, the
  21.                directory where the pmtags executable (PMTAGS.EXE) resides,
  22.                and all directories on the path, for the file.
  23.  
  24.    -v          Verbose.
  25.  
  26.  
  27. DESCRIPTION
  28.    PMTAGS reads an ASCII text file prepared for import into PageMaker, checking
  29.    for errors, and if the -f option is specified, creates a new file (with an
  30.    extension of .TAG) with extra CR and LF characters stripped out.
  31.  
  32.    An ASCII file prepared for import into PageMaker contains style tags of the
  33.    form <stylename>, identifying the PageMaker style to be applied to the
  34.    paragraph.
  35.  
  36.    PMTAGS reads information about the valid styles from PMSTYLES.DAT (or the
  37.    file specified with the -s option).
  38.  
  39.    PMTAGS checks:
  40.  
  41.    * that the style tag starts with "<" and ends with ">".
  42.    * that the style tag does not cross a line boundary.
  43.    * that the style tag starts in column 1.
  44.    * that the style tag is valid.
  45.    * that for specified styles, that style tag is followed by a certain
  46.      sequence of characters.
  47.  
  48.    Each line in PMSTYLES.DAT contains the name of a style, optionally 
  49.    followed by one of the following keywords:
  50.  
  51.    LITERAL   The text of this style is to be represented literally (e.g.
  52.              it might be used to represent computer input/output) and the
  53.              CR/LF characters are not removed from the end of each line.
  54.  
  55.    CHECK=n   The characters following the style tag are checked to make sure
  56.              that they are:
  57.  
  58.              n=1  *\t[text]
  59.              n=2  \t[heading]\t
  60.              n=3  \t\t
  61.              n=4  [text]\t[text]
  62.  
  63.              where \t is the TAB character, [text] is any printable 
  64.              character(s) and [heading] is on of "Syntax", "Description", 
  65.              "Examples", "Messages", "See Also" and "On-line Help".
  66.  
  67.  
  68. COPYRIGHT
  69.    Copyright (c) 1992 Industrial Research Limited, Lower Hutt, New Zealand.
  70.  
  71.  
  72. ERROR MESSAGES
  73.  
  74.    Invalid command line argument - "x"
  75.       x is not a recognised command line argument.  Type "pmtags -h" for
  76.       help.
  77.  
  78.    Multiple file sets not supported - "&"
  79.       PMTAGS does not support the "&" multiple fileset separator (this is a
  80.       feature of the command line parser used).  Re-issue the command without
  81.       the "&".
  82.  
  83.    At least one file specification required
  84.       You must specify at least one file to process.
  85.  
  86.    Will fix errors.
  87.       Informational message displayed when both the -f and -v command line
  88.       options are specified.
  89.  
  90.    Can''t find style file <filename.ext>
  91.       PMTAGS could not locate the style file <filename.ext> in the
  92.       current directory, the directory where PMTAGS.EXE resides or a
  93.       directory specified in the PATH statement.
  94.  
  95.    Can''t open style file <filename.ext>
  96.       PMTAGS was looking for the file <filename.ext> to load information about
  97.       valid styles, but could not find it.  Check that the file exists in the
  98.       current directory, the directory where PMTAGS.EXE resides or a
  99.       directory specified in the PATH statement.
  100.  
  101.    Loading style file <filename.ext>
  102.       Informational message produced (if the -v command line option was
  103.       specified) while PMTAGS is reading style information from the file
  104.       <filename.ext>.
  105.  
  106.    Error reading style file <filename.ext>
  107.       PMTAGS couldn't read the style file <filename.ext>.  Check the file is
  108.       not corrupt or the drive door open.
  109.  
  110.    Too many styles - maximum allowed is 255
  111.       The style file contained definitions of more than 255 styles.
  112.  
  113.    <text> is not a valid style attribute
  114.       The word <text> is not a valid style attribute.  Currently, the only valid attributes
  115.       are LITERAL and CHECK=number.
  116.  
  117.    <tag> is not a valid style tag
  118.       The word <tag> is not a correctly formed style tag - it must start with
  119.       a "<" and end with a ">".
  120.  
  121.    Can''t open file <filename.ext>
  122.       PMTAGS could not open the input file <filename.ext>
  123.  
  124.    Can''t create file <filename.ext>
  125.       PMTAGS could not create the output file <filename.ext>
  126.  
  127.    Error closing file <filename.ext>
  128.       PMTAGS could not close the file <filename.ext>
  129.  
  130.    Error writing to file <filename.ext>
  131.       There was an error writing to the output file <filename.ext>.
  132.       Check that the disk is not full, or the drive door open?
  133.  
  134.    Error reading file <filename.ext>
  135.       at line <#>, column <#>
  136.       There was an error reading the input file <filename.ext> at the
  137.       position specified by the line and column values.  Check that the file
  138.       is not corrupt and the drive door is closed.
  139.  
  140.    filename.ext(line#): expecting "<characters>" after style tag "<tag>"
  141.       The characters following style tag <tag> did not match <characters>,
  142.       which may be one of "*\t[text]", "\t[heading]\t[text]", "\t\t[text]" or
  143.       "[text]\t[text]".
  144.  
  145.    filename.ext(line#): "<heading>" not recognised heading for "<cmd-heading>"
  146.       Expecting one of "Syntax", "Description", "Examples", "Messages",
  147.       "See Also" or "On-line Help".
  148.       Check the spelling and case of <heading> carefully - it must match one
  149.       of the headings listed exactly.
  150.  
  151.    filename.ext(line#): internal error in state machine; state=<#>, event=<#>
  152.       This indicates a major problem in the internal state machine of PMTAGS.
  153.       Contact the author.
  154.  
  155.    filename.ext(line#): "<tag>" is a badly formed style tag
  156.       <tag> contains an embedded "<".  Tags start with a "<", followed by
  157.       any characters other than "<>", and end with a ">".
  158.  
  159.    filename.ext(line#): "<tag>" style tags may not cross line boundaries
  160.       The style tag <tag> is split across a line boundary; the most common
  161.       cause is the terminating ">" missing from the end of the style tag.
  162.  
  163.    filename.ext(line#): <tag> style tag not at start of line
  164.       <tag> is a valid style tag but does not start in column 1.
  165.  
  166.    filename.ext(line#): "<tag>" is not a valid style
  167.       <tag> starts in column 1 but is not a recognised style tag.  If <tag>
  168.       is correct and not meant to be a style tag, move it away from column 1
  169.       to avoid confusing PageMaker.
  170.  
  171.    filename.ext(line#): Is "<tag>" meant to be a style tag?
  172.       <tag> looks like a style tag (ie. starts with "<" and ends with ">")
  173.       but is not a recognised style tag and doesn't start in column 1.  If
  174.       <tag> is correct, ignore the message.
  175.  
  176.    filename.ext(line#): Pre-mature end of file
  177.       PMTAGS reached the end of the input file while still processing a style
  178.       tag (ie, the "<" had been seen, but not the terminating ">"), or still
  179.       checking characters following a style tag.
  180.  
  181.    filename.ext(line#): <#> warnings, <#> errors
  182.       Informational message indicates the completion of processing of input
  183.       file <filename.ext>
  184.  
  185.    filename.ext(line#): <#> warnings, <#> errors, created <filename.ext>
  186.       Informational message indicates the completion of processing of input
  187.       file <filename.ext>, and the creation of the outputfile <filename.ext>.PMTAGS v1.2 - Check/fix style tags in PageMaker ASCII import files
  188.